Skip to content

docs: move audit-channel how-to from recipes to a maintainer ops runbook - #105

Merged
josealekhine merged 1 commit into
mainfrom
docs/audit-channel-ops-home
May 29, 2026
Merged

docs: move audit-channel how-to from recipes to a maintainer ops runbook#105
josealekhine merged 1 commit into
mainfrom
docs/audit-channel-ops-home

Conversation

@josealekhine

Copy link
Copy Markdown
Member

The out-of-band audit channel is maintainer-only (it runs through the ctxctl binary, which ships to no end user), so its how-to does not belong among the user-facing recipes. Relocate it to the operations / contributor surface and make contributing.md the clear entry point.

  • Move docs/recipes/audit-channel.md -> docs/operations/runbooks/audit-channel.md (git rename), beside the other maintainer runbooks (codebase-audit, docs-semantic-audit); fix its now-deeper relative links (banner image, context-health).
  • contributing.md: the ctxctl section now states it covers only build/install and points to the runbook for the full workflow (a clear directive, not a skippable aside).
  • recipes/index.md: replace the full entry with a short pointer to the runbook. Keeps an inbound redirect, removes it from user recipes, and clears the name overlap with recipes/system-hooks-audit.md.
  • zensical.toml + operations/index.md: register the runbook under Operations -> Runbooks.
  • specs/ctxctl-bootstrap.md: update the doc's path reference.
  • Regenerate the docs site (site/**, feed); no orphaned recipe page.

Verification: make lint 0 issues (both modules), make test green (both modules); all changed doc links resolve.

Spec: specs/ctxctl-bootstrap.md

The out-of-band audit channel is maintainer-only (it runs through the
`ctxctl` binary, which ships to no end user), so its how-to does not
belong among the user-facing recipes. Relocate it to the operations /
contributor surface and make contributing.md the clear entry point.

- Move docs/recipes/audit-channel.md ->
  docs/operations/runbooks/audit-channel.md (git rename), beside the
  other maintainer runbooks (codebase-audit, docs-semantic-audit); fix
  its now-deeper relative links (banner image, context-health).
- contributing.md: the ctxctl section now states it covers only
  build/install and points to the runbook for the full workflow (a
  clear directive, not a skippable aside).
- recipes/index.md: replace the full entry with a short pointer to the
  runbook. Keeps an inbound redirect, removes it from user recipes,
  and clears the name overlap with recipes/system-hooks-audit.md.
- zensical.toml + operations/index.md: register the runbook under
  Operations -> Runbooks.
- specs/ctxctl-bootstrap.md: update the doc's path reference.
- Regenerate the docs site (site/**, feed); no orphaned recipe page.

Verification: `make lint` 0 issues (both modules), `make test` green
(both modules); all changed doc links resolve.

Spec: specs/ctxctl-bootstrap.md
Signed-off-by: Jose Alekhinne <jose@ctx.ist>
@josealekhine josealekhine self-assigned this May 29, 2026
@josealekhine
josealekhine requested a review from bilersan as a code owner May 29, 2026 02:33
@josealekhine
josealekhine merged commit fc25ef5 into main May 29, 2026
16 checks passed
@josealekhine
josealekhine deleted the docs/audit-channel-ops-home branch May 29, 2026 02:37
josealekhine added a commit that referenced this pull request Jul 7, 2026
docs: move audit-channel how-to from recipes to a maintainer ops runbook
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant